/**
 * Copyright (c) 2008, Mu Dynamics.
 *  All rights reserved.
 *  
 *   Redistribution and use in source and binary forms, with or without modification, 
 *   are permitted provided that the following conditions are met:
 *   
 *  - Redistributions of source code must retain the above copyright notice, 
 *     this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation and/or 
 *     other materials provided with the distribution.
 *  - Neither the name of the "Mu Dynamics" nor the names of its contributors may be used 
 *     to endorse  or promote products derived from this software without specific prior 
 *     written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.mu.jacob.core.builder;

import java.util.Map;
import java.util.Properties;

import com.mu.jacob.core.model.IModel;

/**
 * Default builder interface
 * @author Adam Smyczek
 */
public interface IBuilder {
	
	/**
	 * Template file name constant used in build.xml configuration file.
	 * The constant references the relative main template file without path
	 */
	public static final String PROPERTY_TEMPLATE_FILE = "template.file";
	
	/**
	 * Template root path where @template.file@ exist
	 */
	public static final String PROPERTY_TEMPLATE_ROOT = "template.root";
	
	/**
	 * Some renderer engine (e.g. FreeMarker) support global template repositories.
	 * Reference this using this constant.
	 */
	public static final String PROPERTY_TEMPLATE_ROOT_GLOBAL = "template.root.global";
	
	/**
	 * Initializes renderer before the build process
	 */
	public void initRenderer();
	
	/**
	 * The build request
	 * @param classDescriptor
	 */
	public void build(IModel model);

	/**
	 * Accessor to builder properties
	 * @return builder properties
	 */
	public Properties getProperties();
	
	/**
	 * The builder context map
	 * @return context map
	 */
	public Map<String, Object> getContextMap();
	
}
